home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / svy3012.zip / SURVEY.DOC < prev    next >
Text File  |  1990-11-01  |  13KB  |  297 lines
  1.  
  2.  
  3.  
  4.                                  Survey  Door
  5.                                 **************
  6.                                   Multi-Node
  7.                                  Version  3.0
  8.                              Release Date 11-01-90
  9.  
  10.                             A Blue Foxx Live Door
  11.                                  Production
  12.  
  13.                                  Written By:
  14.  
  15.                                  Tim Maloney
  16.                                  P.O. Box 230
  17.                                Altus, Ok, 73521
  18.  
  19.                               The Blue Foxx BBS
  20.                                 (405) 482-3855
  21.                              300/1200/2400 24 hrs
  22.  
  23.  
  24.  
  25. Regardless of how you recieved this product it is provided "AS-IS" without
  26. any warranty or guarantee. You the end user accept full responsibilty for
  27. using this product. By using this product you do so solely at your own risk.
  28. You agree to hold the author free from any responsibility regarding loss of
  29. profits, system damage (software or Hardware) or any other incidental,
  30. special or unmentioned damages resulting from the use or inability to use
  31. this end product.
  32.  
  33.  
  34. This product is being distributed under the SHAREWARE concept. You may use it
  35. for a period of time. After this time period you must either register the
  36. product for your own use or discontinue using it. All Blue Foxx products
  37. carry a Date stamp and after a certain period of time the SHAREWARE versions
  38. will no longer function! Registered versions are registered to one individual
  39. only and soley to that individual for use on that individuals own system.
  40. Registered versions will contain an extra file with special information
  41. pertaining to registered users.  The registered versions MAY NOT be
  42. distributed by anyone other than the author of this product. SHAREWARE
  43. (UNREGISTERED) versions may be distributed freely by any BBS as long as no
  44. fee is charged for this particular product and this product is not included
  45. with any other product when distributed. The product must not be modified in
  46. any way, shape or form without the written permission of the author!
  47.  
  48.  
  49.  
  50.  
  51. Now that thats taken care of lets get down to the good stuff!!
  52.  
  53. This Door is a Production of Blue Foxx Software. At some later date in
  54. time it will cease to operate. The time frame may be from already expired
  55. to 3 months or less, depending on when you received this door. This is what
  56. is known as a cripple door, honesty has always been the best policy but
  57. sometimes a small reminder never hurt. I would have liked to distribute
  58. these doors as open as possible but it seems that some people would like
  59. to test the doors for a period that went into years.  If these doors had
  60. a warranty period it would have been up long ago. Anyways I have begun
  61. distributing these doors like this so that everyone will have a some time to
  62. determine if it is what they want or not. Also Registered Version may or may
  63. not have extra or enhanced options for players or Sysops.
  64. If you have any ideas on improving this or any other door that I have wrote,
  65. please feel free to tell me. I'm always looking for suggestions, good or bad.
  66.  
  67.  
  68.  
  69. See the end of this DOC on how to register:
  70.  
  71.  
  72. Now on to the good stuff:
  73.  
  74. All major changes will be marked <NEW>. These should be read as they
  75. may contain information that if not included properly may cause the
  76. door not to operate.
  77. Any other changes were considered to minor to document or place within
  78. this documentation.
  79.  
  80. The following files should be included in this package:
  81.  
  82. SVY*.EXE        Main door program
  83. SURVEYED.EXE    The Editor program to help get started
  84. SURVEY01.QST    An Example survey
  85. SURVEY02.QST    An Example survey
  86. SURVEY.DAT      File containing the Survey Information
  87. SURVEY.CFG      A quick file to get it up in local mode fast.
  88.                 Please rename any config file that you use to
  89.                 SURVEY.CFG or the door may not run properly
  90.                 in LOCAL mode only. (See instructions below)
  91.                 LOCAL IS DEFINED AS FROM DOS. If you enter it
  92.                 while logged on LOCALLY to your BBS it will work
  93.                 with ANY config filename.
  94.  
  95. FILE YOU MUST SUPPLY:
  96. BRUN45.EXE      This must be a patched copy and must be in your PATH
  97.                 (Any patched copy will do, and this file is no longer
  98.                 included in the door program. If you don't have a copy
  99.                 it is on many BBS' already and you may call mine and
  100.                 download it anytime if you need it.
  101. SFDOORS.DAT     Supplied by your BBS. Or the door monitor that you use
  102.                 to run doors for other BBS systems.
  103.  
  104. I suggest you rename the main file to SURVEY.EXE This will help you
  105. to keep track of the associated programs and also make it easier if you
  106. add a newer version. You will not have to change your BAT/Monitor files
  107. in the future, if you start off with a name such as this. All other files
  108. MUST NOT BE RENAMED or an error may result.
  109.  
  110. Other files will be created as the door needs them.
  111. *.LOK           Survey ## that is locked out from other nodes.
  112.                 If a person drops carrier or the Sysop kicks them out
  113.                 while taking a survey. The *.LOK will remain! It will
  114.                 automatically be deleted when the NEXT user goes in the
  115.                 door providing 30 minutes has expired.
  116. *.USR           List of users that have taken a survey
  117. *.BAD           Created when a caller drops carrier in the door. This is
  118.                 to let the Sysop know who may have had a problem in the
  119.                 door and the Sysop can then ask them about it.
  120.                 It has been suggested to have this go to the HEYSYSOP.LOG
  121.                 or the CALLERS.LOG. If you would like to vote on this please
  122.                 let me know. Reason being this door supports different BBS
  123.                 types and making them all compatable can be a chore.
  124.  
  125. *.ERR           Created whenever an ERROR results in the door. This will NOT
  126.                 be created if the door is not properly set up. Most of the
  127.                 ERROR numbers generated can be found in your DOS BASIC
  128.                 reference manual. If you get one that you cannot identify
  129.                 please feel free to leave me a message.
  130.  
  131.  
  132. STEP 1:
  133.         THE CONFIG FILE
  134. Your config file should contain the folowing:
  135.  
  136. REGISTRATION            Enter Your Registration Number
  137. BBSTYPE                 Only SPITFIRE Supported at this time
  138. BBSNAME                 The Name of YOUR BBS
  139. SYSOPFIRST              The Sysops First Name
  140. SYSOPLAST               The Sysops Last Name
  141. c:\xxx\doorinfo.xxx     PATH AND NAME to SFDOORS.DAT
  142. 60                      Max Time a user can be in the door
  143.                         (This only limits their time. So if they have less
  144.                         time available that is what will be used.)
  145.  
  146. NOTE:
  147.         A caller MUST complete all of the questions in a survey before
  148.         it will be updated. If they run out of time before they complete
  149.         the last question, the door will remain open until the bulletins
  150.         and information has been saved. There is NO QUIT once they are
  151.         in a Survey!! Once they complete the last question the door will
  152.         then check for excessive time in the door.
  153.         Only when all questions have been taken by a caller will they no
  154.         longer be allowed to take that Survey. If they are disconnected
  155.         while they are taking a survey they will be allowed to take it the
  156.         next time they call. ANSWERS ARE NOT SAVED/UPDATED UNLESS ALL OF
  157.         THE QUESTIONS ARE TAKEN!!!
  158.  
  159.  
  160. STEP 2:
  161.        DATA FILES:
  162. Just copy all of the above files into the directory that you wish to
  163. run the door from. ONE config file is necessary for EACH node that you
  164. run. ONE must be named SURVEY.CFG to run the door from DOS!
  165. All other files must retain their original names.
  166.  
  167. BRUN45.EXE must be in your path somewhere. Also it must be patched for
  168. DTR or the door may drop carrier on the caller when leaving. It will
  169. work fine locally but not remote. Any patched copy will usually do and
  170. if it is in your path then you will only need ONE copy anywhere on your
  171. drives!!
  172.  
  173. STEP 3:
  174.         STARTING THE DOOR:
  175. This is the easiest part.
  176.  
  177.         A. LOCAL just type the name of the door.
  178.            ex. SURVEY
  179.  
  180.            NOTE: To run from DOS you must have your CFG file named
  181.                  SURVEY.CFG.
  182.  
  183.         B. AS A DOOR:
  184.            First you must Change Directory (CD or CHDIR) into
  185.            the directory containing the door. Then type the name of the
  186.            door ,a space, and the name of your config file.
  187.            ex. CD \DOOR
  188.                SURVEY SURVEY.CFG
  189.            remember to change back to your calling directory with a CD
  190.            on the line following the one that calls the door.
  191.  
  192.            MULTI-NODE OPERATION:
  193.            You must have a seperate CFG file for each Node that you wish
  194.            to put this door on. Only one EXE file is necessary and starting
  195.            the door would be as follows for each door.
  196.  
  197.                  ex. CD\DOOR
  198.                      SURVEY SURVEY2.CFG   <=- Node 2
  199.  
  200.                      CD\DOOR
  201.                      SURVEY SURVEY3.CFG   <=- Node 3 etc
  202.  
  203.            Most Sysops will already be familiar with their BBS Doors and
  204.            will only have to add the above lines into whatever batch file
  205.            of door monitor file that will eventually call the door.
  206.  
  207. EXAMPLE BATCH FILE TO CALL THIS DOOR:
  208. ECHO OFF
  209. E:
  210. CD E:\SF\DOOR
  211. {exefilename} {configfilename}
  212. CD E:\SF
  213.  
  214. The door will sense if you lock DTE and take appropriate steps to insure that
  215. proper locking takes place. The door has only been tested to 19,200 baud and
  216. only on comm ports 1 and 2.
  217.  
  218.  
  219. SET UP OF FILES:
  220.         All files are in standard ASCII text!
  221.  
  222. Layout of SURVEY??.QST
  223. ##              (NUMBER OF QUESTIONS)
  224. QUESTION,##     (QUESTION AND NUMBER OF ANSWERS)
  225. ANSWER??,##     (ANSWERS AND NUMBER OF TIMES SELECTED)
  226.        note: Limiting answers to 8 will present a better appearance
  227.        on the screen.
  228.        Also when making the surveys with the Editor Response #8 will
  229.        automatically become --- OTHER...--- if you wish to change this
  230.        you will have to use a text editor and edit the *.QST file.
  231.  
  232. IMPORTANT:
  233.         All questions and files that have a COMMA in them will have the
  234.         comma saved as a '┐' (ALT 191 or CHR$(191)). So if you edit your
  235.         questions after they are wrote, you will have to change any
  236.         commas that you want with '┐' or they will not look right on
  237.         the screen. (Or the bulletins for that matter!)
  238.  
  239. The *.USR files will be checked each time a user logs on.
  240. If they do not exist they will be created. This results in a
  241. ZERO byte file but this will not take up any extra space on
  242. your drive. Feel free to delete them if you wish, but they will
  243. be created everytime a user logs into the door.
  244.  
  245. If you wish users to be able to take a survey more than one time you
  246. MUST delete the *.USR file for that survey either when they enter or
  247. leave the door!! ex... del survey01.usr.. this deletes the users list
  248. that have take survey01. (The questions are untouched)
  249.  
  250.  
  251. And there you have it.. If I have left anything out or if you have any
  252. suggestions for this or future doors....
  253.  
  254. Give me a call at The Blue Foxx BBS (405) 482-3855 (300/1200/2400 24hrs)
  255.  
  256.  
  257. If you would like to register this program:
  258.  
  259.  
  260.         Send $10 And the Name Of The Door you wish to register.
  261.         To:
  262.            Tim Maloney
  263.            Blue Foxx BBS
  264.            P.O. Box 230
  265.            Altus OK, 73521
  266.  
  267.          Please Include the NAME you wish to Place on Your Registered
  268.          Version. Preferably this is the Sysops First and Last Name.
  269.  
  270. Your Registered Copy will Be available For immediate Download From
  271. the Blue Foxx BBS. If you wish to be pre-registered on the Blue Foxx please
  272. include the folowing with your registration:
  273.         First and Last Name you will use. (No Aliases)
  274.         Password
  275.         Birthdate
  276.         Mailing Address
  277.         City, State & ZIP Code
  278.  
  279. This does not have to be fancy.. Just tear off any old piece of paper and
  280. write clear enough to read and mail it off.
  281.  
  282. If you wish just use the ole Print Screen routine here and fill in the
  283. blanks.. Thats what I see most anyways..
  284.  
  285. SURVEY DOOR $10-----
  286.  
  287. NAME (First and Last) __________________________________
  288.  
  289. Voice Phone Number _____________________________________
  290.  
  291. Password (if not already logged on) ____________________
  292.  
  293. In either Case if you have any suggestions feel free to call and leave
  294. me a comment.
  295.  
  296. *********************************** END OF DOC ****************************
  297.